Delete a Schedule

{ deleteSchedule }

Soft deletes a schedule from the active tasks scheduler.

Method

/API2/tasks/deleteSchedule

  • API Section: /API2/tasks
  • API Version: 2.0
  • From Release: 2018.5
  • Method operates via POST actions only.
    • Input Parameters

    Name

    scheduleId

    Type

    string

    Description

    The schedule's system ID

    Output Response

    Successful Result Code

    200

    Response Type

    ModifiedItemsResult

    Description of Response Type

    Generic API response object with success or failure flag and related messages.

    Notes

    The schedule will not be permanently deleted. Instead it will only be set to status deleted.